home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Apple WWDC 1996
/
WWDC96_1996 (CD).toast
/
Technology Materials
/
MacOS 8 Resources
/
Developer Tools
/
Mac OS 8 Interfaces & Libraries
/
Interfaces
/
IDLIncludes
/
OCEAuthDir.idl
< prev
next >
Wrap
Text File
|
1996-05-01
|
78KB
|
1,665 lines
/*
File: OCEAuthDir.idl
Contains: Apple Open Collaboration Environment Authentication Interfaces.
Version: Technology: AOCE Toolbox 1.02
Release: Universal Interfaces 3.0d3 on Copland DR1
Copyright: © 1984-1996 by Apple Computer, Inc. All rights reserved.
Bugs?: If you find a problem with this file, send the file and version
information (from above) and the problem description to:
Internet: apple.bugs@applelink.apple.com
AppleLink: APPLE.BUGS
*/
#ifndef __OCEAUTHDIR_IDL__
#define __OCEAUTHDIR_IDL__
#include <somobj.idl>
#include <somcls.idl>
#ifndef __APPLETALK_IDL__
#include <AppleTalk.idl>
#endif
#ifndef __FILES_IDL__
#include <Files.idl>
#endif
#ifndef __OSUTILS_IDL__
#include <OSUtils.idl>
#endif
#ifndef __TYPES_IDL__
#include <Types.idl>
#endif
#ifndef __OCE_IDL__
#include <OCE.idl>
#endif
#ifdef __SOMIDL__
#if FOR_SYSTEM7_ONLY
/*****************************************************************************/
/* Values of DirEnumChoices */
typedef unsigned long DirEnumChoices;
/* Values of DirSortOption */
/* Values of DirSortDirection */
/* Values of DirMatchWith */
typedef octet DirMatchWith; /* Substituted octet for unsigned char type */
/*
Access controls are implemented on three levels:
* DNode, Record, and Attribute Type levels
* Some access control bits apply to the container itself, and some apply to its contents.
*
* The Catalog Toolbox supports six functions. These calls are:
* DSGetDNodeAccessControl : to get Access Controls at the DNode level
* DSGetRecordAccessControl : to get Access Controls at the record level
* DSGetAttributeAccessControl : to get Access Privileges at the attribute type level
*
* The GetXXXAccessControl calls will return access control masks for various categories
* of users. Please refer to the access control document for a description of the
* categories of users. In general these are:
* ThisRecordOwner - means the identity of the record itself
* Friends - means any one of the assigned friends for the record
* AuthenticatedInDNode - means any valid user that is an authenticated entity
* in the DNode in which this record is located
* AuthenticatedInDirectory - means any valid authenticated catalog user
* Guest - means an unauthenticated user.
* Bit masks for various permitted access controls are defined below.
*
* GetXXXAccessControl calls will return access control masks for various categories of
* users for this record. In addition they also return the level of access controls
* that the user (who is making the GetXXXAccessControl call) has for the DNode,
* record, or attribute type.
*
* For records, the access control granted will be minimum of the DNode access
* control and record access control masks. For example, to add an attribute type to a
* record, a user must have access control kCreateAttributeTypes at the record and
* DNode levels. Similarly, at the attribute type level, access controls will be the
* minimum of the DNode, record, and attribute type access controls.
*
*
*/
/* access privileges bit numbers */
/* Values of AccessMask */
/*
kSupportsDNodeNumberBit:
If this bit is set, a DNode can be referenced using DNodeNumbers.
RecordLocationInfo can be specified using DNodeNumber and PathName component can be nil.
If this bit is not set, a DNode can be referenced only by PathName to the DNode. In the
later case DNodeNumber component inside record location info must be set to zero.
kSupportsRecordCreationIDBit:
If this bit is set, a record can be referenced by specifying CreationID
in most catalog manager calls. If this bit is not set recordName and recordType are
required in the recordID specification for all catalog manager calls.
kSupportsAttributeCreationIDBit:
If this bit is set, an attribute value can be obtained by specifying it's
CreationID in Lookup call staring point and also can be used in operations
like DeleteAttributeValue and ChangeAttributeValue an Attribute can be
specified by AttributeType and CreationID.
*************************************************************************
Implicit assumption with creationID's and dNodeNumbers are, when supported
they are persistent and will preserved across boots and life of the system.
*************************************************************************
Following three bits are for determining the sort order in enumeration.
kSupportsMatchAllBit:
If this bit is set, enumeration of all the records is supported
kSupportsBeginsWithBit:
If this bit is set, enumeration of records matching prefix (e.g. Begin with abc)
is supported
kSupportsExactMatchBit:
If this bit is set, existence of a record matching exact matchNameString and recordType
is supported.
kSupportsEndsWithBit:
If this bit is set, enumeration of records matching suffix (e.g. end with abc)
is supported.
kSupportsContainsBit:
If this bit is set, enumeration of records containing a matchNameString (e.g. containing abc)
is supported
Implicit assumption in all these is, a record type can be specified either as one of the above or
a type list(more then one) to match exact type.
The Following four bits will indicate sort ordering in enumeration.
kSupportsOrderedEnumerationBit:
If this bit is set, Enumerated records or in some order possibly in name order.
kCanSupportNameOrderBit:
If this is set, catalog will support sortbyName option in Enumerate.
kCanSupportTypeOrderBit:
If this bit is set, catalog will support sortbyType option in enumearte.
kSupportSortBackwardsBit:
If this bit is set, catalog supports backward sorting.
kSupportIndexRatioBit:
If this bit is set, it indicates that enumeration will return approximate position
of a record (percentile) among all records.
kSupportsEnumerationContinueBit:
If this bit is set, catalog supports enumeration continue.
kSupportsLookupContinueBit:
If this bit is set, catalog supports lookup continue.
kSupportsEnumerateAttributeTypeContinueBit:
If this bit is set, catalog supports EnumerateAttributeType continue.
kSupportsEnumeratePseudonymContinueBit:
If this bit is set, catalog supports EnumeratePseudonym continue.
kSupportsAliasesBit:
If this bit is set, catalog supports create/delte/enumerate
of Alias Records.
kSupportPseudonymBit:
If this bit is set, catalog supports create/delte/enumerate of
pseudonyms for a record.
kSupportsPartialPathNameBit:
If this bit is set, catalog nodes can be specified using DNodeNumber of a
intermediate DNode and a partial name starting from that DNode to the intended
DNode.
kSupportsAuthenticationBit:
If this bit is set, catalog supports authentication manager calls.
kSupportsProxiesBit:
If this bit is set, catalog supports proxy related calls in authentication manager.
kSupportsFindRecordBit:
If this bit is set, catalog supports find record call.
Bits and corresponding masks are as defined below.
*/
/* values of DirGestalt */
/* Values of AuthLocalIdentityOp */
/* Values of AuthLocalIdentityLockAction */
/* Values of AuthNotifications */
typedef unsigned short DirSortOption;
typedef unsigned short DirSortDirection;
typedef unsigned long AccessMask;
typedef unsigned long DirGestalt;
typedef unsigned long AuthLocalIdentityOp;
typedef unsigned long AuthLocalIdentityLockAction;
typedef unsigned long AuthNotifications;
typedef SOMLargeStruct DNodeID; /* Derived from a struct of 16 bytes in size */
typedef SOMLargeStruct DirEnumSpec; /* Derived from a struct of 38 bytes in size */
typedef SOMLargeStruct DirMetaInfo; /* Derived from a struct of 16 bytes in size */
typedef SOMLargeStruct SLRV; /* Derived from a struct of 8 bytes in size */
/* Catalog types and operations */
/* unique identifier for an identity */
typedef unsigned long AuthIdentity;
/* Umbrella LocalIdentity */
typedef AuthIdentity LocalIdentity;
/* A DES key is 8 bytes of data */
typedef SOMLargeStruct DESKey; /* Derived from a struct of 8 bytes in size */
typedef OpaquePtr RC4Key; /* Substituted OpaquePtr for array of Byte of size 8 */
typedef unsigned long AuthKeyType;
/* key type followed by its data */
typedef SOMLargeStruct AuthKey; /* Derived from a struct of 20 bytes in size */
typedef OpaquePtr AuthKeyPtr; /* Substituted OpaquePtr for ``AuthKey*'' */
typedef OpaquePtr AuthParamBlockPtr; /* Substituted OpaquePtr for ``AuthParamBlock*'' */
/* Fix parameter passing convention (#1274062) ggs, 8-7-95 */
typedef OpaquePtr AuthIOCompletionProcPtr;
typedef OpaquePtr AuthIOCompletionUPP;
/*
****************************************************************************
Authentication Manager operations
****************************************************************************
*/
/*
kAuthResolveCreationID:
userRecord will contain the user information whose creationID has to be
returned. A client must make this call when he does not know the creaitionID.
The creationID must be set to nil before making the call. The server will attempt
to match the recordid's in the data base which match the user name and
type in the record. Depending on number of matchings, following
results will be returned.
Exactly One Match : CreationID in RecordID and also in buffer (if buffer is given)
totalMatches = actualMatches = 1.
> 1 Match:
Buffer is Large Enough:
totalMatches = actualMatches
Buffer will contain all the CIDs, kOCEAmbiguousMatches error.
> 1 Match:
Buffer is not Large Enough:
totalMatches > actualMatches
Buffer will contain all the CIDs (equal to actualMatches), daMoreDataError error.
0 Matches:
kOCENoSuchRecord error
*/
typedef SOMLargeStruct AuthResolveCreationIDPB; /* Derived from a struct of 82 bytes in size */
/*
kAuthBindSpecificIdentity:
userRecord will contain the user information whose identity has to be
verified. userKey will contain the userKey. An Identity is returned which
binds the key and the userRecord. The identity returned can be used in the 'identity'
field in the header portion (AuthParamHeader) for authenticating the Catalog and
Authentication manager calls.
*/
typedef SOMLargeStruct AuthBindSpecificIdentityPB; /* Derived from a struct of 74 bytes in size */
/*
kAuthUnbindSpecificIdentity:
This call will unbind the userRecord and key which were bind earlier.
*/
typedef SOMLargeStruct AuthUnbindSpecificIdentityPB; /* Derived from a struct of 66 bytes in size */
/*
kAuthGetSpecificIdentityInfo:
This call will return the userRecord for the given identity. Note: key is not
returned because this would compromise security.
*/
typedef SOMLargeStruct AuthGetSpecificIdentityInfoPB; /* Derived from a struct of 70 bytes in size */
/*
kAuthAddKey:
userRecord will contain the user information whose identity has to be
created. userKey will point to the key to be created. password points to
an RString containing the password used to generate the key.
*/
typedef SOMLargeStruct AuthAddKeyPB; /* Derived from a struct of 74 bytes in size */
/*
kAuthChangeKey:
userRecord will contain the user information whose identity has to be
created. userKey will point to the key to be created. password points to
an RString containing the password used to generate the key.
*/
typedef SOMLargeStruct AuthChangeKeyPB; /* Derived from a struct of 74 bytes in size */
/*
AuthDeleteKey:
userRecord will contain the user information whose Key has to be deleted.
*/
typedef SOMLargeStruct AuthDeleteKeyPB; /* Derived from a struct of 66 bytes in size */
/* AuthPasswordToKey: Converts an RString into a key. */
typedef SOMLargeStruct AuthPasswordToKeyPB; /* Derived from a struct of 74 bytes in size */
/*
kAuthGetCredentials:
userRecord will contain the user information whose identity has to be
kMailDeletedMask. keyType (e.g. asDESKey) will indicate what type of key has to
be deleted.
*/
typedef SOMLargeStruct AuthGetCredentialsPB; /* Derived from a struct of 86 bytes in size */
/*
AuthDecryptCredentialsPB:
Changes:
userKey is changed userIdentity.
userRecord is changed to initiatorRecord. User must supply buffer
to hold initiatorRecord.
agentList has changed to agent. There wil be no call back.
User must supply buffer to hold agent Record.
An additional boolean parameter 'hasAgent' is included.
Toolbox will set this if an 'Agent' record is found in the
credentials. If RecordIDPtr is 'nil', no agent record will
be copied. However user can examine 'hasAgent', If true user
can reissue this call with apprpriate buffer for getting a recordID.
agent has changed to intermediary. User must supply buffer to hold
intermediary Record. The toolbox will set 'hasIntermediary' if an
'intermediary' record is found in the credentials.
*/
typedef SOMLargeStruct AuthDecryptCredentialsPB; /* Derived from a struct of 96 bytes in size */
typedef SOMLargeStruct AuthMakeChallengePB; /* Derived from a struct of 78 bytes in size */
typedef SOMLargeStruct AuthMakeReplyPB; /* Derived from a struct of 86 bytes in size */
typedef SOMLargeStruct AuthVerifyReplyPB; /* Derived from a struct of 82 bytes in size */
/*
kAuthGetUTCTime:
RLI will contain a valid RLI for a cluster server.
UTC(GMT) time from one of the cluster server will be returned.
An 'offSet' from UTC(GMT) to Mac Local Time will also be returned.
If RLI is nil Map DA is used to determine UTC(GMT).
Mac Local Time = theUTCTime + theUTCOffset.
*/
typedef SOMLargeStruct AuthGetUTCTimePB; /* Derived from a struct of 74 bytes in size */
/*
kAuthMakeProxy:
A user represented bu the 'userIdentity' can make a proxy using this call.
'recipient' is the RecordID of the recipient whom user is requesting proxy.
'intermediary' is the RecordID of the intermediary holding proxy for the user.
'firstValid' is time at which proxy becomes valid.
'expiry' is the time at which proxy must expire.
'proxyLength' will have the length of the buffer pointed by 'proxy' as input.
When the call completes, it will hold the actual length of proxy. If the
call completes 'kOCEMoreData' error, client can reissue the call with the
buffer size as 'proxyLength' returned.
expiry is a suggestion, and may be adjusted to be earlier by the ADAP/OCE server.
The 'proxy' obtained like this might be used by the 'intermediary' to obtain credentials
for the server using TradeProxyForCredentials call.
authDataLength and authData are intended for possible future work, but are
ignored for now.
*/
typedef SOMLargeStruct AuthMakeProxyPB; /* Derived from a struct of 98 bytes in size */
/*
kAuthTradeProxyForCredentials:
Using this call, intermediary holding a 'proxy' for a recipient may obtain credentials
for that recipient. 'userIdentity' is the identity for the 'intermediary'.
'recipient' is the RecordID for whom credetials are requested.
'principal' is the RecordID of the user who created the proxy.
'proxyLength' is the length of data pointed by 'proxy.
If the call is succesfull, credentials will be returned in the
buffer pointed by 'credentials'. 'expiry' is the desired expiry time at input.
When call succeds this will have expiry time of credentials.
This is very similar to GetCredentials except that we (of course) need the proxy,
but we also need the name of the principal who created the proxy.
*/
typedef SOMLargeStruct AuthTradeProxyForCredentialsPB; /* Derived from a struct of 98 bytes in size */
/* API for Local Identity Interface */
/*
AuthGetLocalIdentityPB:
A Collaborative application intended to work under the umbrella of LocalIdentity
for the OCE toolbox will have to make this call to obtain LocalIdentity.
If LocalIdentity has not been setup, then application will get
'kOCEOCESetupRequired.'. In this case application should put the dialog
recommended by the OCE Setup document and guide the user through OCE Setup.
If the OCESetup contains local identity, but user has not unlocked, it will get
kOCELocalAuthenticationFail. In this case application should use SDPPromptForLocalIdentity
to prompt user for the password.
If a backGround application or stand alone code requires LocalIdentity, if it gets the
OSErr from LocalIdentity and can not call SDPPromptForLocalIdentity, it should it self
register with the toolbox using kAuthAddToLocalIdentityQueue call. It will be notified
when a LocalIdentity gets created by a foreground application.
*/
typedef SOMLargeStruct AuthGetLocalIdentityPB; /* Derived from a struct of 66 bytes in size */
/*
kAuthUnlockLocalIdentity:
The LocalIdentity can be created using this call.
The userName and password correspond to the LocalIdentity setup.
If the password matches, then collabIdentity will be returned.
Typically SDPPromptForLocalIdentity call will make this call.
All applications which are registered through kAuthAddToLocalIdentityQueue
will be notified.
*/
typedef SOMLargeStruct AuthUnlockLocalIdentityPB; /* Derived from a struct of 74 bytes in size */
/*
kAuthLockLocalIdentity:
With this call existing LocalIdentity can be locked. If the ASDeleteLocalIdetity
call fails with 'kOCEOperationDenied' error, name will contain the application which
denied the operation. This name will be supplied by the application
when it registered through kAuthAddToLocalIdentityQueue call
*/
typedef SOMLargeStruct AuthLockLocalIdentityPB; /* Derived from a struct of 70 bytes in size */
typedef OpaquePtr NotificationProcPtr;
typedef OpaquePtr NotificationUPP;
typedef NotificationUPP NotificationProc;
/*
kAuthAddToLocalIdentityQueue:
An application requiring notification of locking/unlocking of the
LocalIdentity can install itself using this call. The function provided
in 'notifyProc' will be called whenever the requested event happens.
When an AuthLockLocalIdentity call is made to the toolbox, the notificationProc
will be called with 'kAuthLockPending'. The application may refuse the lock by returning
a 'true' value. If all the registered entries return 'false' value, locking will be done
successfully. Otherwise 'kOCEOperationDenied' error is returned to the caller. The appName
(registered with the notificationProc) of the application which denied locking is also
returned to the caller making the AuthLockIdentity call.
*/
typedef SOMLargeStruct AuthAddToLocalIdentityQueuePB; /* Derived from a struct of 74 bytes in size */
/*kAuthRemoveFromLocalIdentityQueue:*/
typedef SOMLargeStruct AuthRemoveFromLocalIdentityQueuePB; /* Derived from a struct of 66 bytes in size */
/*
kAuthSetupLocalIdentity:
The LocalIdentity can be Setup using this call.
The userName and password correspond to the LocalIdentity setup.
If a LocalIdentity Setup already exists 'kOCELocalIdentitySetupExists' error
will be returned.
*/
typedef SOMLargeStruct AuthSetupLocalIdentityPB; /* Derived from a struct of 74 bytes in size */
/*
kAuthChangeLocalIdentity:
An existing LocalIdentity Setup can be changed using this call.
The userName and password correspond to the LocalIdentity setup.
If a LocalIdentity Setup does not exists 'kOCEOCESetupRequired' error
will be returned. The user can use kAuthSetupLocalIdentity call to setit up.
If the 'password' does not correspond to the existing setup, 'kOCELocalAuthenticationFail'
OSErr will be returned. If successful, LocalID will have new name as 'userName' and
password as 'newPassword' and if any applications has installed into
LocalIdentityQueue with kNotifyNameChangeMask set, it will be notified with
kAuthLocalIdentityNameChangeOp action value.
*/
typedef SOMLargeStruct AuthChangeLocalIdentityPB; /* Derived from a struct of 78 bytes in size */
/*
kAuthRemoveLocalIdentity:
An existing LocalIdentity Setup can be removed using this call.
The userName and password correspond to the LocalIdentity setup.
If a LocalIdentity Setup does not exists 'kOCEOCESetupRequired' error
will be returned.
If the 'password' does not correspond to the existing setup, 'kOCELocalAuthenticationFail'
OSErr will be returned. If successful, LocalIdentity will be removed from the OCE Setup.
This is a very distructive operation, user must be warned enough before actually making
this call.
*/
typedef SOMLargeStruct AuthRemoveLocalIdentityPB; /* Derived from a struct of 74 bytes in size */
/*
kOCESetupAddDirectoryInfo:
Using this call identity for a catalog can be setup under LocalIdentity umbrella.
ASCreateLocalIdentity should have been done succesfully before making this call.
directoryRecordCID -> is the record creationID obtained when DirAddOCEDirectory or
DirAddDSAMDirectory call was made.
rid-> is the recordID in which the identity for the catalog will be established.
password-> the password associated with the rid in the catalog world.
*/
typedef SOMLargeStruct OCESetupAddDirectoryInfoPB; /* Derived from a struct of 78 bytes in size */
/*
kOCESetupChangeDirectoryInfo:
Using this call an existing identity for a catalog under LocalIdentity umbrella
can be changed.
ASCreateLocalIdentity should have been done succesfully before making this call.
directoryRecordCID -> is the record creationID obtained when DirAddOCEDirectory or
DirAddDSAMDirectory call was made.
rid-> is the recordID in which the identity for the catalog will be established.
password-> the password associated with the rid in the catalog world.
newPassword -> the new password for the catalog
*/
typedef SOMLargeStruct OCESetupChangeDirectoryInfoPB; /* Derived from a struct of 82 bytes in size */
/*
kOCESetupRemoveDirectoryInfo:
Using this call an existing identity for a catalog under LocalIdentity umbrella
can be changed.
ASCreateLocalIdentity should have been done succesfully before making this call.
directoryRecordCID -> is the record creationID obtained when DirAddOCEDirectory or
*/
typedef SOMLargeStruct OCESetupRemoveDirectoryInfoPB; /* Derived from a struct of 70 bytes in size */
/*
kOCESetupGetDirectoryInfo:
Using this call info on an existing identity for a particular catalog under LocalIdentity umbrella
can be obtained.
For the specified catalog 'directoryName' and 'discriminator', rid and nativeName will
returned. Caller must provide appropriate buffer to get back rid and nativeName.
'password' will be returned for non-ADAP Catalogs.
*/
typedef SOMLargeStruct OCESetupGetDirectoryInfoPB; /* Derived from a struct of 86 bytes in size */
/*
****************************************************************************
Catalog Manager operations
****************************************************************************
*/
typedef OpaquePtr DirParamBlockPtr; /* Substituted OpaquePtr for ``DirParamBlock*'' */
typedef OpaquePtr DirIOCompletionProcPtr;
typedef OpaquePtr DirIOCompletionUPP;
/* AddRecord */
typedef SOMLargeStruct DirAddRecordPB; /* Derived from a struct of 68 bytes in size */
/* DeleteRecord */
typedef SOMLargeStruct DirDeleteRecordPB; /* Derived from a struct of 66 bytes in size */
/* aRecord must contain valid PackedRLI and a CreationID. */
/**********************************************************************************/
/*
DirEnumerate:
This call can be used to enumerate both DNodes and records under a specified
DNode. A DNode is specified by the PackedRLIPtr 'aRLI'.
startingPoint indicates where to start the enumeration. Initially,
it should be set to a value of nil. After some records are enumerated,
the client can issue the call again with the same aRLI and recordName and
typeList. The last received DirEnumSpec in the startingPoint field. The server
will continue the enumeration from that record on. if user wants to get back the
value specified in the startingRecord also, the Boolean 'includeStartingPoint'
must be set to 'true'. If this is set to 'false', records specified after the
startingPoint record will be returned.
sortBy indicates to the server to return the records that match in name-first
or type-first order. sortDirection indicates to the server to search in forward
or backward sort order for RecordIDs Specified.
RecordIDS and Enumeration Criteria:
PackedRLIPtr parameter 'aRLI' will be accepted for DNode
specification.
One RStringPtr 'nameMatchString' is provided. User is allowed to
specify a wild card in the name. WildCard specification is specified in
matchNameHow parameter and possible values are defined in DirMatchWith Enum.
'typeCount' parameter indicate how many types are in the 'typeList'.
'typeList' parmeter is a pointer to an RString array of size 'typeCount'.
If 'typeCount' is exactly equal to one, a wild card can be specified
for the entity type; otherwise types have to be completely specified.
WildCard specification is specified in matchNameHow parameter
and possible values are defined in DirMatchWith Enum.
A nil value for 'startingPoint' is allowed when sortDirection specified
is 'kSortBackwards'. This was not allowed previously.
'enumFlags' parameter is a bit field. The following bits can be set:
kEnumDistinguishedNameMask to get back records in the cluster data base.
kEnumAliasMask to get back record aliases
kEnumPseudonymMask to get back record pseudonyms
kEnumDNodeMask to get back any children dNodes for the DNode specified in the
'aRLI' parameter.
kEnumForeignDNodeMask to get back any children dNodes which have ForeignDnodes in the
dNode specified in the 'aRLI' parameter.
kEnumAll is combination of all five values and can be used to enumerate
everything under a specified DNode.
The results returned for each element will consist of a DirEnumSpec.
The DirEnumSpec contains 'enumFlag' which indicates the type of entity and a
union which will have either DNodeID or LocalRecordID depending on the value of 'enumFlag'.
The 'enumFlag' will indicate whether the returned element is a
record(kEnumDistinguishedNameMask bit) or a alias(kEnumAliasMask bit) or a
Pseudonym(kEnumPseudonymMask) or a child DNode(kEnumDNodeMask bit). If the 'enumFlag' value
is kEnumDnodeMask, it indicates the value returned in the union is a DNodeID (i.e. 'dNodeNumber'
is the 'dNodeNumber' of the child dnode(if the catalog supports dNodeNumbers, otherwise
this will be set to zero). The name will be the child dnode name. For other values of the
'enumFlag', the value in the union will be LocalRecordID. In addition to kEnumDnodeMask it is
possible that kEnumForeignDNodeMask is also set. This is an advisory bit and application must make
it's own decision before displaying these records. If catalog supports kSupportIndexRatioMask, it
may also return the relative position of the record (percentile of total records) in the
indexRatio field in EnumSpec.
responseSLRV will contain the script, language, region and version of the oce sorting software.
The results will be collected in the 'getBuffer' supplied by the user.
If buffer can not hold all the data returned 'kOCEMoreData' error will be returned.
If user receives 'noErr' or 'kOCEMoreData', buffer will contain valid results. A user
can extract the results in the 'getBuffer' by making DirEnumerateParse' call.
*/
typedef SOMLargeStruct DirEnumerateGetPB; /* Derived from a struct of 114 bytes in size */
/* The EnumerateRecords call-back function is defined as follows: */
typedef OpaquePtr ForEachDirEnumSpecProcPtr;
typedef OpaquePtr ForEachDirEnumSpecUPP;
typedef ForEachDirEnumSpecUPP ForEachDirEnumSpec;
/*
EnumerateParse:
After an EnumerateGet call has completed, call EnumerateParse
to parse through the buffer that was filled in EnumerateGet.
'eachEnumSpec' will be called each time to return to the client a
DirEnumSpec that matches the pattern for enumeration. 'enumFlag' indicates the type
of information returned in the DirEnumSpec
The clientData parameter that you pass in the parameter block will be passed
to 'forEachEnumDSSpecFunc'. You are free to put anything in clientData - it is intended
to allow you some way to match the call-back to the original call (for
example, you make more then one aysynchronous EnumerateGet calls and you want to
associate returned results in some way).
The client should return FALSE from 'eachEnumSpec' to continue
processing of the EnumerateParse request. Returning TRUE will
terminate the EnumerateParse request.
For synchronous calls, the call-back routine actually runs as part of the same thread
of execution as the thread that made the EnumerateParse call. That means that the
same low-memory globals, A5, stack, etc. are in effect during the call-back
that were in effect when the call was made. Because of this, the call-back
routine has the same restrictions as the caller of EnumerateParse:
if EnumerateParse was not called from interrupt level, then the call-
back routine can allocate memory. For asynchronous calls, call-back routine is
like a ioCompletion except that A5 will be preserved for the application.
*/
typedef SOMLargeStruct DirEnumerateParsePB; /* Derived from a struct of 114 bytes in size */
/*
* FindRecordGet operates similarly to DirEnumerate except it returns a list
* of records instead of records local to a cluster.
*/
typedef SOMLargeStruct DirFindRecordGetPB; /* Derived from a struct of 114 bytes in size */
/* The FindRecordParse call-back function is defined as follows: */
typedef OpaquePtr ForEachRecordProcPtr;
typedef OpaquePtr ForEachRecordUPP;
typedef ForEachRecordUPP ForEachRecord;
/*
* This PB same as DirFindRecordGet except it includes the callback function
*/
typedef SOMLargeStruct DirFindRecordParsePB; /* Derived from a struct of 118 bytes in size */
/*
LookupGet:
aRecordList is an array of pointers to RecordIDs, each of which must
contain valid PackedRLI and a CreationID. recordIDCount is
the size of this array.
attrTypeList is an array of pointers to AttributeTypes. attrTypeCount is
the size of this array.
staringRecordIndex is the record from which to continue the lookup.
If you want to start from first record in the list, this must be 1 (not zero).
This value must always be <= recordIDCount.
startingAttributeIndex is the AttributeType from which we want to continue the lookup.
If you want to start from first attribute in the list, this must be 1 (not zero).
This value must always be <= attrTypeCount.
startingAttribute is the value of the attribute value from which we want to
continue lookup. In case of catalogs supporting creationIDs, startingAttribute
may contain only a CID. Other catalogs may require the entire value.
If a non-null cid is given and if an attribute value with that cid is not found, this
call will terminate with kOCENoSuchAttribute error. A client should not make a LookupParse call
after getting this error.
'includeStartingPoint' boolean can be set to 'true' to receive the value specified in the
startingPoint in the results returned. If this is set to 'false', the value
specified in the startingAttribute will not be returned.
When LookupGet call fails with kOCEMoreData, the client will be able to find out where the call ended
with a subsequent LookupParse call. When the LookupParse call completes with kOCEMoreData,
lastRecordIndex, lastAttributeIndex and lastValueCID will point to the corresponding
recordID, attributeType and the CreationID of the last value returned successfully. These parameters
are exactly the same ones for the startingRecordIndex, startingAttributeIndex, and startingAttrValueCID
so they can be used in a subsequent LookupGet call to continue the lookup.
In an extreme case, It is possible that we had an attribute value that is too large to fit
in the client's buffer. In such cases, if it was the only thing that we tried to fit
into the buffer, the client will not able to proceed further because he will not know the
attributeCID of the attribute to continue with. Also he does not know how big a buffer
would be needed for the next call to get this 'mondo' attribute value successfully.
to support this, LookupParse call will do the following:
If LookupGet has failed with kOCEMoreData error, LookupParse will check to make sure that
ForEachAttributeValueFunc has been called at least once. If so, the client has the option
to continue from that attribute CreationID (for PAB/ADAP) in the next LookupGet call.
However, if it was not even called once, then the attribute value may be too big to fit in the
user's buffer. In this case, lastAttrValueCID (lastAttribute) and attrSize are returned in the
parse buffer and the call will fail with kOCEMoreAttrValue. However, it is possible that
ForEachAttributeValue was not called because the user does not have read access to some of
the attributeTypes in the list, and the buffer was full before even reading the creationID of
any of the attribute values. A kOCEMoreData error is returned.
The Toolbox will check for duplicate RecordIDs in the aRecordList. If found, it will return
'daDuplicateRecordIDErr'.
The Toolbox will check for duplicate AttributeTypes in the attrTypeList. If found it will
return 'daDuplicateAttrTypeErr'.
*/
typedef SOMLargeStruct DirLookupGetPB; /* Derived from a struct of 174 bytes in size */
/* The Lookup call-back functions are defined as follows: */
typedef OpaquePtr ForEachLookupRecordIDProcPtr;
typedef OpaquePtr ForEachLookupRecordIDUPP;
typedef ForEachLookupRecordIDUPP ForEachLookupRecordID;
typedef OpaquePtr ForEachAttrTypeLookupProcPtr;
typedef OpaquePtr ForEachAttrTypeLookupUPP;
typedef ForEachAttrTypeLookupUPP ForEachAttrTypeLookup;
typedef OpaquePtr ForEachAttrValueProcPtr;
typedef OpaquePtr ForEachAttrValueUPP;
typedef ForEachAttrValueUPP ForEachAttrValue;
/*
LookupParse:
After a LookupGet call has completed, call LookupParse
to parse through the buffer that was filled in LookupGet. The
toolbox will parse through the buffer and call the appropriate call-back routines
for each item in the getBuffer.
'eachRecordID' will be called each time to return to the client one of the
RecordIDs from aRecordList. The clientData parameter that you
pass in the parameter block will be passed to eachRecordID.
You are free to put anything in clientData - it is intended to allow
you some way to match the call-back to the original call (in case, for
example, you make simultaneous asynchronous LookupGet calls). If you don't
want to get a call-back for each RecordID (for example, if you're looking up
attributes for only one RecordID), pass nil for eachRecordID.
After forEachLocalRecordIDFunc is called, eachAttrType may be called to pass an
attribute type (one from attrTypeList) that exists in the record specified
in the last eachRecordID call. If you don't want to get a call-back for
each AttributeType (for example, if you're looking up only one attribute type,
or you prefer to read the type from the Attribute struct during the eachAttrValue
call-back routine), pass nil for eachAttrType. However access controls may
prohibit you from reading some attribute types; in that case eachAttrValue
may not be called even though the value exists. Hence the client should
supply this call-back function to see the access controls for each attribute type.
This will be followed by one or more calls to eachAttrValue, to pass the
type, tag, and attribute value. NOTE THIS CHANGE: you are no longer expected to
pass a pointer to a buffer in which to put the value. Now you get a pointer to
the value, and you can process it within the call-back routine.
After one or more values are returned, eachAttrType may be called again to pass
another attribute type that exists in the last-specified RecordID.
The client should return FALSE from eachRecordID, eachAttrType, and
eachAttrValue to continue processing of the LookupParse request. Returning TRUE
from any call-back will terminate the LookupParse request.
If LookupGet has failed with kOCEMoreData error, LookupParse will check to make sure that
ForEachAttributeValueFunc has been called at least once. If so, the client has the option
to continue from that attribute CreationID (for PAB/ADAP) in the next LookupGet call.
However, if it was not even called once, then the attribute value may be too big to fit in the
user's buffer. In this case, lastAttrValueCID (lastAttribute) and attrSize are returned in the
parse buffer and the call will fail with kOCEMoreAttrValue. However, it is possible that
ForEachAttributeValue was not called because the user does not have read access to some of
the attributeTypes in the list, and the buffer was full before even reading the creationID of
any of the attribute values. A kOCEMoreData error is returned.
For synchronous calls, the call-back routine actually runs as part of the same thread
of execution as the thread that made the LookupParse call. That means that the
same low-memory globals, A5, stack, etc. are in effect during the call-back
that were in effect when the call was made. Because of this, the call-back
routine has the same restrictions as the caller of LookupParse:
if LookupParse was not called from interrupt level, then the call-
back routine can allocate memory. For asynchronous calls, call-back routine is
like a ioCompletion except that A5 will be preserved for the application.
*/
typedef SOMLargeStruct DirLookupParsePB; /* Derived from a struct of 174 bytes in size */
/* AddAttributeValue */
typedef SOMLargeStruct DirAddAttributeValuePB; /* Derived from a struct of 70 bytes in size */
/*
aRecord must contain valid PackedRLI and a CreationID.
Instead of passing type, length, and value in three separate
fields, we take a pointer to an Attribute structure that contains
all three, and has room for the AttributeCreationNumber.
The AttributeCreationID will be returned in the attr itself.
The AttributeTag tells the catalog service that the attribute is an RString,
binary, or a RecordID.
*/
/*
DeleteAttributeType:
This call is provided so that an existing AttributeType can be deleted.
If any attribute values exist for this type, they will all be deleted
(if the user has access rights to delete the values) and then the attribute type
will be deleted. Otherwise dsAccessDenied error will be returned.
*/
typedef SOMLargeStruct DirDeleteAttributeTypePB; /* Derived from a struct of 70 bytes in size */
/*
DeleteAttributeValue
*/
typedef SOMLargeStruct DirDeleteAttributeValuePB; /* Derived from a struct of 70 bytes in size */
/*
ChangeAttributeValue:
currentAttr ==> the attribute to be changed. For ADAS and PAB CreationID is
sufficient
newAttr ==> new value for the attribute. For ADAS and PAB
CreationID field will be set when
the call succeesfully completes
aRecord ==> must contain valid PackedRecordLocationInfo and a CreationID.
*/
typedef SOMLargeStruct DirChangeAttributeValuePB; /* Derived from a struct of 74 bytes in size */
/* VerifyAttributeValue */
typedef SOMLargeStruct DirVerifyAttributeValuePB; /* Derived from a struct of 70 bytes in size */
/*
aRecord must contain valid PackedRLI and a CreationID.
The attribute type and value are passed in the attribute structure. If the
attribute CreationID is non-zero, the server will verify that an attribute with
the specified value and creation number exists in aRecord. If the attribute
CreationID is zero, the server will verify the attribute by type and value
alone, and return the attribute CreationID in the Attribute struct if the
attribute exists.
*/
/*
EnumerateAttributeTypesGet:
The following two calls can be used to enumerate the attribute types present in
a specified RecordID. The first, EnumerateAttributeTypesGet, processes the request
and reads the response into getBuffer, as much as will fit. A kOCEMoreData error will
be returned if the buffer was not large enough. After this call completes, the
client can call EnumerateAttributeTypesParse (see below).
The user will able to continue from a startingPoint by setting a startingAttrType.
Typically, this should be the last value returned in EnumerateAttributeTypesParse call
when 'kOCEMoreData' is returned.
If 'includeStartingPoint' is true when a 'startingAttrType' is specified, the starting value
will be included in the results, if it exists. If this is set to false, this value will not
be included. AttributeTypes following this type will be returned.
*/
typedef SOMLargeStruct DirEnumerateAttributeTypesGetPB; /* Derived from a struct of 106 bytes in size */
/* The call-back function is defined as follows: */
typedef OpaquePtr ForEachAttrTypeProcPtr;
typedef OpaquePtr ForEachAttrTypeUPP;
typedef ForEachAttrTypeUPP ForEachAttrType;
/*
EnumerateAttributeTypesParse:
After an EnumerateAttributeTypesGet call has completed, call EnumerateAttributeTypesParse
to parse through the buffer that was filled in EnumerateAttributeTypesGet. The
toolbox will parse through the buffer and call the call-back routine for
each attribute type in the getBuffer.
The client should return false from eachAttrType to continue
processing of the EnumerateAttributeTypesParse request. Returning true will
terminate the EnumerateAttributeTypesParse request. The clientData parameter that
you pass in the parameter block will be passed to eachAttrType.
You are free to put anything in clientData - it is intended to allow
you some way to match the call-back to the original call (in case, for
example, you make simultaneous asynchronous calls).
For synchronous calls, the call-back routine actually runs as part of the same thread
of execution as the thread that made the EnumerateAttributeTypesParse call. That means that the
same low-memory globals, A5, stack, etc. are in effect during the call-back
that were in effect when the call was made. Because of this, the call-back
routine has the same restrictions as the caller of EnumerateAttributeTypesParse.
If EnumerateAttributeTypesParse was not called from interrupt level, then the call-
back routine can allocate memory. For asynchronous calls, call-back routine is
like a ioCompletion except that A5 will be preserved for the application.
*/
typedef SOMLargeStruct DirEnumerateAttributeTypesParsePB; /* Derived from a struct of 106 bytes in size */
/*
DirAbort:
With this call a user will able to abort an outstanding catalog service call.
A user must pass a pointer to the parameter block for the outstanding call.
In the current version of the product, the toolbox will process this call
for NetSearchADAPDirectoriesGet or FindADAPDirectoryByNetSearch calls and if possible
it will abort. For other calls for ADAP and PAB this will return 'daAbortFailErr'.
For CSAM catalogs, this call will be passed to the corresponding CSAM driver.
The CSAM driver may process this call or may return 'daAbortFailErr'. This call can
be called only in synchronous mode. Since the abort call makes references to fields in
the pb associated with the original call, this pb must not be disposed or or altered if
the original call completes before the abort call has completed.
*/
typedef SOMLargeStruct DirAbortPB; /* Derived from a struct of 66 bytes in size */
/*
AddPseudonym:
An alternate name and type can be added to a given record. If allowDuplicate
is set the name and type will be added even if the same name and type already
exists.
*/
typedef SOMLargeStruct DirAddPseudonymPB; /* Derived from a struct of 76 bytes in size */
/*
DeletePseudonym:
An alternate name and type for a given record can be deleted.
*/
typedef SOMLargeStruct DirDeletePseudonymPB; /* Derived from a struct of 74 bytes in size */
/*
AddAlias:
This call can be used to create an alias record. The alias
can be created either in the same or different cluster. ADAS will not support
this call for this release. A new catalog capability flag 'kSupportsAlias' will indicate
if the catalog supports this call. PAB's will support this call. For the PAB implementation,
this call will create a record with the name and type specified an aRecord.
This call works exactly like AddRecord.
If 'allowDuplicate' is false and another record with same name and type already exists
'daNoDupAllowed' error will be returned.
*/
typedef SOMLargeStruct DirAddAliasPB; /* Derived from a struct of 68 bytes in size */
/*
DirFindValue:
This call can be used to find the occurrence of a value. The value
to be matched is passed in the buffer 'matchingData' field. The current
ADAP/PAB implementation will match a maximum of 32 bytes of data.
For attribute values in the PAB/ADAP implementation, only the first 32 bytes will
be used for comparing the occurrence of data. Search can be restricted to
a particular record and/or attribute type by specifying 'aRecord' or 'aType'.
After finding one occurrence, 'startingRecord' and 'startingAttribute'
can be specified to find the next occurrence of the same value.
'sortDirection' can be specified with starting values to search forward or backward.
When a matching value is found, the 'recordFound' indicates the reccordID in which the
data occurrence was found, 'attributeFound' indicates the attribute with in which the
matching data was found. ADAP/PAB implementation returns only the type and creationID of
attributes. Catalogs which don't support creationIDs may return the
complete value; hence this call may need a buffer to hold the data. For ADAP/PAB implementations
the user has to make a DirLookup call to get the actual data. 'recordFound' and
'attributeFound' can be used to initialize 'startingRecord' and 'startingAttribute' to
find the next occurrence of the value.
*/
typedef SOMLargeStruct DirFindValuePB; /* Derived from a struct of 152 bytes in size */
/*
EnumeratePseudonymGet:
This call can be used to enumerate the existing pseudonyms for
a given record specified in 'aRecord'. A starting point can be specified
by 'startingName' and 'startingType'. If the 'includeStartingPoint' boolean
is true and a starting point is specified, the name specified by startingName
and startingType also is returned in the results, if it exists. If this is set to false,
the pseudonym in startingName and Type is not included.
Pseudonyms returned in the 'getBuffer' can be extracted by making an
EnumeratePseudonymParse call. The results will consist of a RecordID with the
name and type of the pseudonym. If the buffer could not hold all the results, then
'kOCEMoreData' error will be returned. The user will be able to continue the call by
using the last result returned as starting point for the next call.
*/
typedef SOMLargeStruct DirEnumeratePseudonymGetPB; /* Derived from a struct of 106 bytes in size */
/* The call-back function is defined as follows: */
typedef OpaquePtr ForEachRecordIDProcPtr;
typedef OpaquePtr ForEachRecordIDUPP;
typedef ForEachRecordIDUPP ForEachRecordID;
/*
EnumeratePseudonymParse:
The pseudonyms returned in the 'getBuffer' from the EnumeratePseudonymGet call
can be extracted by using the EnumeratePseudonymParse call. 'eachRecordID'
will be called for each pseudonym.
Returning true from any call-back will terminate the EnumeratePseudonymParse call.
For synchronous calls, the call-back routine actually runs as part of the same thread
of execution as the thread that made the EnumeratePseudonymParse call. That means that the
same low-memory globals, A5, stack, etc. are in effect during the call-back
that were in effect when the call was made. Because of this, the call-back
routine has the same restrictions as the caller of EnumeratePseudonymParse:
if EnumeratePseudonymParse was not called from interrupt level, then the call-
back routine can allocate memory. For asynchronous calls, call-back routine is
like a ioCompletion except that A5 will be preserved for the application.
*/
typedef SOMLargeStruct DirEnumeratePseudonymParsePB; /* Derived from a struct of 106 bytes in size */
/* GetNameAndType */
typedef SOMLargeStruct DirGetNameAndTypePB; /* Derived from a struct of 66 bytes in size */
/*
aRecord must contain valid RLI and a CreationID. It
must also contain pointers to maximum-length RStrings (name and type fields)
in which will be returned the record's distinguished name and type.
*/
/*
SetNameAndType:
This call can be used to change a name and type for a record. The record
to be renamed is specified using 'aRecord'.
'newName' and 'newType' indicate the name and type to be set.
'allowDuplicate' if true indicates that name is to be set even if another
name and type exactly matches the newName and newType specified.
'newName' and 'newType' are required since the catalogs not supporting
CreationID require name and type fields in the recordID to identify a given
record.
*/
typedef SOMLargeStruct DirSetNameAndTypePB; /* Derived from a struct of 76 bytes in size */
/*
DirGetMetaRecordInfo: This call can be made to obtain
the MetaRecordInfo for a given record. Information returned
is 16 bytes of OPAQUE information about the record.
*/
typedef SOMLargeStruct DirGetRecordMetaInfoPB; /* Derived from a struct of 82 bytes in size */
/*
DirGetDNodeMetaInfo: This call can be made to obtain
the DNodeMetaInfo for a given Packed RLI. Information returned
is 16 bytes of OPAQUE information about the DNode.
*/
typedef SOMLargeStruct DirGetDNodeMetaInfoPB; /* Derived from a struct of 82 bytes in size */
/*
EnumerateDirectoriesGet:
A user can enumerate all the catalogs installed. This includes installed
ADAP and CSAM catalogs. The user can specify a signature as input to restrict
the results. kDirADAPKind will return only ADAP catalogs, kDirDSAMKind
will return all CSAM catalogs. kDirAllKinds will get both ADAP & CSAM catalogs.
A specific signature (e.g. X.500) may be used to get catalogs with an X.500 signature.
The information for each catalog returned will have directoryName, discriminator and features.
If the user receives 'noErr' or 'kOCEMoreData', the buffer will contain valid results. A user
can extract the results in the 'getBuffer' by making an DirEnumerateDirectories call.
If 'kOCEMoreData' is received, the user can continue enumeration by using the last catalog and
discriminator as startingDirectoryName and staringDirDiscriminator in the next call.
If 'includeStartingPoint' is true and a starting point is specified,
the staring point will be returned in the result. If false, it is not included.
*/
typedef SOMLargeStruct DirEnumerateDirectoriesGetPB; /* Derived from a struct of 106 bytes in size */
typedef OpaquePtr ForEachDirectoryProcPtr;
typedef OpaquePtr ForEachDirectoryUPP;
typedef ForEachDirectoryUPP ForEachDirectory;
/*
EnumerateDirectoriesParse:
The catalog info returned in 'getBuffer' from the EnumerateDirectoriesGet call
can be extracted using the EnumerateDirectoriesParse call. 'eachDirectory' will
be called for each catalog.
Returning true from any call-back will terminate the EnumerateDirectoriesParse call.
For synchronous calls, the call-back routine actually runs as part of the same thread
of execution as the thread that made the EnumerateDirectoriesParse call. That means that the
same low-memory globals, A5, stack, etc. are in effect during the call-back
that were in effect when the call was made. Because of this, the call-back
routine has the same restrictions as the caller of EnumerateDirectoriesParse:
if EnumerateDirectoriesParse was not called from interrupt level, then the call-
back routine can allocate memory. For asynchronous calls, call-back routine is
like a ioCompletion except that A5 will be preserved for the application.
eachDirectory will be called each time to return to the client a
DirectoryName, DirDiscriminator, and features for that catalog.
*/
typedef SOMLargeStruct DirEnumerateDirectoriesParsePB; /* Derived from a struct of 106 bytes in size */
/*
The Following five call are specific to ADAP Catalogs. Toolbox
remembers a list of catalogs across boots. If any catalog service
call is intended for a ADAP catalog, then it must be in the list.
In order for managing this list, A client (Probably DE will use these
calls.
DirAddADAPDirectoryPB: Add a new ADAP catalog to the list.
DirRemoveADAPDirectory: Remove a ADAP catalog from the list.
DirNetSearchADAPDirectoriesGet: search an internet for adas catalogs.
DirNetSearchADAPDirectoriesParse: extract the results obtained NetSearchADAPDirectoriesGet.
DirFindADAPDirectoryByNetSearch: Find a specified catalog through net search.
*/
/*
NetSearchADAPDirectoriesGet:
This call can be used to make a network wide search for finding ADAP catalogs.
This call will be supported only by 'ADAP' and involve highly expensive
network operations, so the user is advised to use utmost discretion before
making this call. The results will be collected in the 'getbuffer' and can be
extracted using NetSearchADAPDirectoriesParse call. The directoryName,
the directoryDiscriminator, features and serverHint (AppleTalk address for
a PathFinder serving that catalog) are collected for each catalog found
on the network. If buffer is too small to hold all the catalogs found on
the network, a 'kOCEMoreData' error will be returned.
*/
typedef SOMLargeStruct DirNetSearchADAPDirectoriesGetPB; /* Derived from a struct of 74 bytes in size */
typedef OpaquePtr ForEachADAPDirectoryProcPtr;
typedef OpaquePtr ForEachADAPDirectoryUPP;
typedef ForEachADAPDirectoryUPP ForEachADAPDirectory;
/*
DirNetSearchADAPDirectoriesParse:
This call can be used to extract the results obtained in the 'getBuffer'.
The directoryName, directoryDiscriminator, features and
serverHint (AppleTalk address for a PathFinder serving that catalog) are
returned in each call-back. These values may be used to make an
AddADAPDirectory call.
Returning TRUE from any call-back will terminate the NetSearchADAPDirectoriesParse request.
For synchronous calls, the call-back routine actually runs as part of the same thread
of execution as the thread that made the DirNetSearchADAPDirectoriesParse call. That means that the
same low-memory globals, A5, stack, etc. are in effect during the call-back
that were in effect when the call was made. Because of this, the call-back
routine has the same restrictions as the caller of DirNetSearchADAPDirectoriesParse:
if DirNetSearchADAPDirectoriesParse was not called from interrupt level, then the call-
back routine can allocate memory. For asynchronous calls, call-back routine is
like a ioCompletion except that A5 will be preserved for the application.
*/
typedef SOMLargeStruct DirNetSearchADAPDirectoriesParsePB; /* Derived from a struct of 74 bytes in size */
/*
DirFindADAPDirectoryByNetSearch:
This call can be used to make a network wide search to find an ADAP catalog.
This call will be supported only by 'ADAP' and involves highly expensive
network operations, so the user is advised to use utmost discretion before
making this call. The catalog is specified using directoryName and discriminator.
If 'addToOCESetup' is true, the catalog will be automatically added to the setup
list and will be visible through the EnumerateDirectories call and also
also a creationID to the directoryRecord will be returned.
If this parameter is set to 'false', the catalog will be added to temporary list
and will be available for making other catalog service calls. The catalogs
which are not in the preference catalog list will not be visible through the
EnumerateDirectories call.
*/
typedef SOMLargeStruct DirFindADAPDirectoryByNetSearchPB; /* Derived from a struct of 84 bytes in size */
/*
DirAddADAPDirectory:
The catalog specified by 'directoryName' and 'discriminator' will be
added to the list of catalogs maintained by the Toolbox. Once added,
the catalog is available across boots, until the catalog is removed
explicitly through a DirRemoveADAPDirectory call.
If 'serverHint' is not nil, the address provided will be used
to contact a PathFinder for the catalog specified.
If 'serverHint' is nil or does not point to a valid PathFinder server
for that catalog, this call will fail.
If 'addToOCESetup' is true, the catalog will be automatically added to the setup
catalog list and will be visible through EnumerateDirectories calls and
also a creationID to the directoryRecord will be returned.
If this parameter is set to 'false', catalog will be added to temprary list
and will be available for making other catalog service calls. The catalogs
which are not in the setup list will not be visible through
EnumerateDirectories call.
*/
typedef SOMLargeStruct DirAddADAPDirectoryPB; /* Derived from a struct of 84 bytes in size */
/*
GetDirectoryInfo:
DirGetDirectoryInfo will do:
If a 'dsRefNum' is non-Zero, the catalog information for
the corresponding PAB will be returned.
If 'dsRefNum' is zero and 'serverHint' is non-zero, If the
'serverHint' points to a valid ADAP Catalog Server(Path Finder),
the catalog information (i.e. directoryName, discriminator, features)
for that catalog will be returned.
If a valid catalog name and discriminator are provided
features (Set of capability flags) for that catalog will be returned.
*/
typedef SOMLargeStruct DirGetDirectoryInfoPB; /* Derived from a struct of 78 bytes in size */
/*
* Note on Access Controls:
* Access control is based on a list model.
* You can get access controls list which gives dsObject and accMask for each dsObject.
* GetAccessControl can be limited to currently supplied identity by setting forCurrentUserOnly.
* There are special DSObjects are defined in ADASTypes.h for each of the category
* supported in ADAS Catalogs. (kOwner, kFriends, kAuthenticatedToCluster,
* kAuthenticatedToDirectory, kGuest) and DUGetActlDSSpec call can be used
* to obtain appropraiate DSSpec before making set calls to ADAS catalogs.
*
*/
/*
GetDNodeAccessControlGet:
This call can be done to get back access control list for a DNode.
pRLI -> RLI of the DNode whose access control list is sought
curUserAccMask -> If this is 'true', Access controls for the user specified by
the identity parameter will be returned other wise entire list
will be returned.
startingDsObj -> If this is not nil, list should be started after this object.
startingPointInclusive -> If staringDsObj is specified, include that in the returned
results.
The results will be collected in the 'getBuffer' supplied by the user.
If buffer can not hold all the data returned 'daMoreData' error will be returned.
If user receives 'noErr' or 'daMoreData', buffer will contain valid results. A user
can extract the results in the 'getBuffer' by making 'DsGetDNodeAccessControlParse' call.
Results returned for each DSObject will contain DSSpecPtr and three sets of access mask.
*/
typedef SOMLargeStruct DirGetDNodeAccessControlGetPB; /* Derived from a struct of 98 bytes in size */
/* The Access Control call-back function is defined as follows: */
typedef OpaquePtr ForEachDNodeAccessControlProcPtr;
typedef OpaquePtr ForEachDNodeAccessControlUPP;
typedef ForEachDNodeAccessControlUPP ForEachDNodeAccessControl;
/*
GetDNodeAccessControlParse:
After an GetDNodeAccessControlGet call has completed,
call GetDNodeAccessControlParse to parse through the buffer that
that was filled in GetDNodeAccessControlGet.
'eachObject' will be called each time to return to the client a
DsObject and a set of three accMasks (three long words) for that object.
Acceesmasks returned apply to the dsObject in the callback :
1. Currently Active Access mask for the specified DNode.
2. Default Access mask for any Record in the DNode
3. Default Access mask for any Attribute in the DNode
The clientData parameter that you pass in the parameter block will be passed
to 'eachObject'. You are free to put anything in clientData - it is intended
to allow you some way to match the call-back to the original call (for
example, you make more then one aysynchronous GetDNodeAccessControlGet calls and you want to
associate returned results in some way).
The client should return FALSE from 'eachObject' to continue
processing of the GetDNodeAccessControlParse request. Returning TRUE will
terminate the GetDNodeAccessControlParse request.
For synchronous calls, the call-back routine actually runs as part of the same thread
of execution as the thread that made the GetDNodeAccessControlParse call. That means that the
same low-memory globals, A5, stack, etc. are in effect during the call-back
that were in effect when the call was made. Because of this, the call-back
routine has the same restrictions as the caller of GetDNodeAccessControlParse:
if GetDNodeAccessControlParse was not called from interrupt level, then the call-
back routine can allocate memory. For asynchronous calls, call-back routine is
like a ioCompletion except that A5 will be preserved for the application.
*/
typedef SOMLargeStruct DirGetDNodeAccessControlParsePB; /* Derived from a struct of 98 bytes in size */
/*
GetRecordAccessControlGet:
This call can be done to get back access control list for a RecordID.
aRecord -> RecordID to which access control list is sought
curUserAccMask -> If this is 'true', Access controls for the user specified by
the identity parameter will be returned other wise entire list
will be returned.
startingDsObj -> If this is not nil, list should be started after this object.
startingPointInclusive -> If staringDsObj is specified, include that in the returned
results.
The results will be collected in the 'getBuffer' supplied by the user.
If buffer can not hold all the data returned 'daMoreData' error will be returned.
If user receives 'noErr' or 'daMoreData', buffer will contain valid results. A user
can extract the results in the 'getBuffer' by making 'DsGetDNodeAccessControlParse' call.
Results returned for each DSObject will contain DSSpecPtr and accMask.
*/
typedef SOMLargeStruct DirGetRecordAccessControlGetPB; /* Derived from a struct of 98 bytes in size */
/* The Access Control call-back function is defined as follows: */
typedef OpaquePtr ForEachRecordAccessControlProcPtr;
typedef OpaquePtr ForEachRecordAccessControlUPP;
typedef ForEachRecordAccessControlUPP ForEachRecordAccessControl;
/*
GetRecordAccessControlParse:
After an GetRecordAccessControlGet call has completed,
call GetRecordAccessControlParse to parse through the buffer that
that was filled in GetRecordAccessControlGet.
'eachObject' will be called each time to return to the client a
DsObject and a set of three accMasks (three long words) for that object.
Acceesmasks returned apply to the dsObject in the callback :
1. Active Access mask for the DNode Containing the Record.
2. Active Access mask for the Record specified.
3. Defualt Access mask for Attributes in the record.
The clientData parameter that you pass in the parameter block will be passed
to 'eachObject'. You are free to put anything in clientData - it is intended
to allow you some way to match the call-back to the original call (for
example, you make more then one aysynchronous GetRecordAccessControlGet calls and you want to
associate returned results in some way).
The client should return FALSE from 'eachObject' to continue
processing of the GetRecordAccessControlParse request. Returning TRUE will
terminate the GetRecordAccessControlParse request.
For synchronous calls, the call-back routine actually runs as part of the same thread
of execution as the thread that made the GetRecordAccessControlParse call. That means that the
same low-memory globals, A5, stack, etc. are in effect during the call-back
that were in effect when the call was made. Because of this, the call-back
routine has the same restrictions as the caller of GetRecordAccessControlParse:
if GetRecordAccessControlParse was not called from interrupt level, then the call-
back routine can allocate memory. For asynchronous calls, call-back routine is
like a ioCompletion except that A5 will be preserved for the application.
*/
typedef SOMLargeStruct DirGetRecordAccessControlParsePB; /* Derived from a struct of 98 bytes in size */
/*
GetAttributeAccessControlGet:
This call can be done to get back access control list for a attributeType with in a RecordID.
aRecord -> RecordID to which access control list is sought
aType -> Attribute Type to which access controls are sought
curUserAccMask -> If this is 'true', Access controls for the user specified by
the identity parameter will be returned other wise entire list
will be returned.
startingDsObj -> If this is not nil, list should be started after this object.
startingPointInclusive -> If staringDsObj is specified, include that in the returned
results.
The results will be collected in the 'getBuffer' supplied by the user.
If buffer can not hold all the data returned 'daMoreData' error will be returned.
If user receives 'noErr' or 'daMoreData', buffer will contain valid results. A user
can extract the results in the 'getBuffer' by making 'DsGetDNodeAccessControlParse' call.
Results returned for each DSObject will contain DSSpecPtr and accMask.
*/
typedef SOMLargeStruct DirGetAttributeAccessControlGetPB; /* Derived from a struct of 98 bytes in size */
/* The Access Control call-back function is defined as follows: */
typedef OpaquePtr ForEachAttributeAccessControlProcPtr;
typedef OpaquePtr ForEachAttributeAccessControlUPP;
typedef ForEachAttributeAccessControlUPP ForEachAttributeAccessControl;
/*
GetAttributeAccessControlParse:
After an GetAttributeAccessControlGet call has completed,
call GetAttributeAccessControlParse to parse through the buffer that
that was filled in GetAttributeAccessControlGet.
'eachObject' will be called each time to return to the client a
DsObject and a set of three accMasks (three long words) for that object.
Acceesmasks returned apply to the dsObject in the callback :
1. Active Access mask for the DNode Containing the Attribute.
2. Active Access mask for the Record in the Containing the Attribute.
3. Active Access mask for the specified Attribute.
The clientData parameter that you pass in the parameter block will be passed
to 'eachObject'. You are free to put anything in clientData - it is intended
to allow you some way to match the call-back to the original call (for
example, you make more then one aysynchronous GetAttributeAccessControlGet calls and you want to
associate returned results in some way).
The client should return FALSE from 'eachObject' to continue
processing of the GetAttributeAccessControlParse request. Returning TRUE will
terminate the GetAttributeAccessControlParse request.
For synchronous calls, the call-back routine actually runs as part of the same thread
of execution as the thread that made the GetAttributeAccessControlParse call. That means that the
same low-memory globals, A5, stack, etc. are in effect during the call-back
that were in effect when the call was made. Because of this, the call-back
routine has the same restrictions as the caller of GetAttributeAccessControlParse:
if GetAttributeAccessControlParse was not called from interrupt level, then the call-
back routine can allocate memory. For asynchronous calls, call-back routine is
like a ioCompletion except that A5 will be preserved for the application.
*/
typedef SOMLargeStruct DirGetAttributeAccessControlParsePB; /* Derived from a struct of 98 bytes in size */
/*
MapPathNameToDNodeNumber:
This call maps a given PathName within a catalog to its DNodeNumber.
*/
typedef SOMLargeStruct DirMapPathNameToDNodeNumberPB; /* Derived from a struct of 82 bytes in size */
/*
PathName in the path field will be mapped to the cooresponding dNodeNumber and
returned in the DNodeNumber field. directoryName and descriminator Fields are
ignored. DSRefNum is used to identify the catalog.
*/
/*
MapDNodeNumberToPathName:
This call will map a given DNodeNumber with in a catalog to the
corresponding PathName.
*/
typedef SOMLargeStruct DirMapDNodeNumberToPathNamePB; /* Derived from a struct of 84 bytes in size */
/*
dNodeNumber in the DNodeNumber field will be mapped to the cooresponding
pathName and returned in the PackedPathName field.
lengthOfPathName is to be set the length of pathName structure.
If length of PackedPathName is larger then the lengthOfPathName, kOCEMoreData
OSErr will be returned.
*/
/*
GetLocalNetworkSpec:
This call will return the Local NetworkSpec. Client should supply
an RString big enough to hold the NetworkSpec.
*/
typedef SOMLargeStruct DirGetLocalNetworkSpecPB; /* Derived from a struct of 78 bytes in size */
/*
PathName in the path field must be set to nil. internetName should be large
enough to hold the internetName. InterNetname returned indicates path finder's
local internet (configured by administrator).
*/
/*
GetDNodeInfo:
This call will return the information (internetName and descriptor)
for the given RLI of a DNode.
*/
typedef SOMLargeStruct DirGetDNodeInfoPB; /* Derived from a struct of 74 bytes in size */
/*
If DnodeNumber is set to a non zero value, path should be set to nil.
if DnodeNumber is set to zero, pathName should point to a packed path name.
internetName should be large enough to hold
the internetName. (If the internetName is same as the one got by
GetLocalInternetName call, it indicates cluster is reachable without
forwarders, --> Tell me if I am wrong)
*/
/*
DirCreatePersonalDirectory:
A new personal catalog can be created by specifying an FSSpec for
the file. If a file already exists dupFNErr will be returned. This call is
supported 'synchronous' mode only.
*/
typedef SOMLargeStruct DirCreatePersonalDirectoryPB; /* Derived from a struct of 74 bytes in size */
/*
DirOpenPersonalDirectory:
An existing personal catalog can be opened using this call.
User can specify the personal catalog by FSSpec for the AddressBook file.
'accessRequested' field specifies open permissions. 'fsRdPerm' & 'fsRdWrPerm'
are the only accepted open modes for the address book.
When the call completes successfully, a dsRefNum will be returned. The 'dsRefNum'
field is in the DSParamBlockHeader. In addittion 'accessGranted' indicates
actual permission with personal catalog is opened and 'features' indicate the capabilty flags
associated with the personal catalog.
This call is supported 'synchronous' mode only.
*/
typedef SOMLargeStruct DirOpenPersonalDirectoryPB; /* Derived from a struct of 72 bytes in size */
/*
DirClosePersonalDirectory: This call lets a client close AddressBook opened by DirOpenPersonalDirectory.
The Personal Catalog specified by the 'dsRefNum' will be closed.
This call is supported 'synchronous' mode only.
*/
typedef SOMLargeStruct DirClosePersonalDirectoryPB; /* Derived from a struct of 62 bytes in size */
/*
DirMakePersonalDirectoryRLI: With this call a client can make an RLI
for a Personal Catalog opened by DirOpenPersonalDirectory Call.
A packed RLI is created for the Personal Catalog specified by the 'dsRefNum'.
If a client has a need to make the AddressBook reference to persistent
acrross boots it should make use of this call. In the current implementaion
PackedRLI has an embeeded System7.0 'alias'. If in later time
If client has a need to make reference to the AddressBook, it must use
ADAPLibrary call 'DUExtractAlias' and resole the 'alias' to 'FSSpec' and
make DirOpenPersonalDirectory call to get a 'dsRefNum'.
'fromFSSpec' FSPecPtr from which relative alias to be created. If nil,
absolute alias is created.
'pRLIBufferSize' indicates the size of buffer pointed by 'pRLI'
'pRLISize' indicates the actual length of 'pRLI'. If the call
fails with 'kOCEMoreData' error a client can reissue
this call with a larger buffer of this length.
'pRLI' is pointer to the buffer in which 'PackedRLI' is
returned.
This call is supported in 'synchronous' mode only.
*/
typedef SOMLargeStruct DirMakePersonalDirectoryRLIPB; /* Derived from a struct of 74 bytes in size */
/*
****************************************************************************
The calls described below apply only for CSAM Drivers:
The following three calls provide capability to Install/Remove a CSAM at RunTime.
DirAddDSAM
DirRemoveDSAM
DirInstantiateDSAM
The following two calls provide capability to Install/Remove a CSAM Catalog at RunTime.
DirAddDSAMDirectory
DirRemoveDirectory
DirGetDirectoryIcon call is used by clients to get any special icon associated
with a CSAM catalog.
****************************************************************************
*/
/*
DirAddDSAM: This call can be used to inorm the availability of a CSAM file
after discovering the CSAM file.
dsamName -> is generic CSAM name e.g. Untitled X.500 directory
dsamSignature -> could be generic CSAM kind e.g. 'X500'.
fsSpec -> is the FileSpec for the file containing CSAM resources.
If the call is successfull 'DSAMRecordCID' will be returned. If the
call returns 'daDSAMRecordCIDExists', record was already there and
'dsamRecordCID' will be returned.
This call can be done only in synchronous mode.
*/
typedef SOMLargeStruct DirAddDSAMPB; /* Derived from a struct of 82 bytes in size */
/*
DirInstantiateDSAM: This call should be used by the CSAM driver in response
Driver Open call to indicate the toolbox about the availability of the CSAM.
dsamName -> is generic CSAM name e.g. Untitled X.500 directory
dsamKind -> could be generic CSAM kind e.g. 'X500'.
dsamData -> pointer to private DSAMData. This will be paased back to the CSAM
when the CSAM functions (DSAMDirProc,DSAMDirParseProc, DSAMAuthProc) are called.
CSAM should already be setup using DirAddDSAM call.
DSAMDirProc -> This procedure will be called when any catalog service
call intended for the CSAM (other then parse calls)
DSAMDirParseProc -> This procedure will be called when any of the parse calls
are called.
DSAMAuthProc -> This procedure will be called when any of the Authentication Calls
are made to the CSAM. If the CSAM does not support authentication, this can be nil.
This call can be done only in synchronous mode.
*/
typedef OpaquePtr DSAMDirProcPtr;
typedef OpaquePtr DSAMDirUPP;
typedef DSAMDirUPP DSAMDirProc;
typedef OpaquePtr DSAMDirParseProcPtr;
typedef OpaquePtr DSAMDirParseUPP;
typedef DSAMDirParseUPP DSAMDirParseProc;
typedef OpaquePtr DSAMAuthProcPtr;
typedef OpaquePtr DSAMAuthUPP;
typedef DSAMAuthUPP DSAMAuthProc;
typedef SOMLargeStruct DirInstantiateDSAMPB; /* Derived from a struct of 86 bytes in size */
/*
DirRemoveDSAM: This call can be used to remove a CSAM file from the OCE Setup.
dsamRecordCID -> is the creationID of the CSAM record.
This call can be made only in synchronous mode.
*/
typedef SOMLargeStruct DirRemoveDSAMPB; /* Derived from a struct of 70 bytes in size */
/*
DirAddDSAMDirectory: This call can be used to inorm the availability of a CSAM catalog.
dsamRecordCID -> recordID for the CSAM serving this catalog
directoryName -> name of the catalog
discriminator -> discriminator for the catalog
directoryRecordCID -> If the call is successful, creationID for the record will
be returned.
*/
typedef SOMLargeStruct DirAddDSAMDirectoryPB; /* Derived from a struct of 94 bytes in size */
/*
DirRemoveDirectory: This call can be used to inform the toolbox that
catalog specified by 'directoryRecordCID'
*/
typedef SOMLargeStruct DirRemoveDirectoryPB; /* Derived from a struct of 70 bytes in size */
/*
* DSGetExtendedDirectoriesInfo:: This call can be used to get
* the information of various foreign catalogs supported.
* Typically a DE Template may make this call to create a
* Address template or a Gateway may make this call to findout
* catalog name space in which MSAM may would support.
* Client will supply a buffer pointed by 'bufferPtr' of size 'bufferLength'.
* When the call completes with 'daMoreData' error, client can examine 'totalEntries'
* returned and reissue the call with increaing buffer.
* Toolbox will findout the private information of each of the Foreign Catalogs
* by polling CSAM's, Gateways, and MnMServers. The Information returned
* for each catalog will be packed in the format:
* typedef struct EachDirectoryData {
* PackedRLI pRLI; // packed RLI for the catalog
* OSType entnType; // Entn Type
* long hasMailSlot; // If this catalog has mail slot this will be 1 otherwise zero
* ProtoRString RealName; // Packed RString for Real Name (padded to even boundary)
* ProtoRString comment; // Packed RString holding any comment for Display (padded to even boundary)
* long length; // data length
* char data[length]; // data padded to even boundary
* };
*
*
*
* typedef struct myData {
* EachDirectoryData data[numberOfEntries]; // data packed in the above format
* };
*
*/
typedef SOMLargeStruct DirGetExtendedDirectoriesInfoPB; /* Derived from a struct of 78 bytes in size */
/*
DirGetDirectoryIconPB: With this call a client can find out about
the icons supported by the Catalog.
Both ADAP and Personal Catalog will not support this call for now.
A CSAM can support a call so that DE Extension can use this
call to find appropriate Icons.
Returns kOCEBufferTooSmall if icon is too small, but will update iconSize.
*/
typedef SOMLargeStruct DirGetDirectoryIconPB; /* Derived from a struct of 78 bytes in size */
/*
DirGetOCESetupRefNum: This call will return 'dsRefnum' for the OCE Setup Personal Catalog
and oceSetupRecordCID for the oceSetup Record.
Clients interested in manipulating OCE Setup Personal Catalog directly should
make this call to get 'dsRefNum'.
'dsRefNum' will be returned in the standard field in the DirParamHeader.
*/
typedef SOMLargeStruct DirGetOCESetupRefNumPB; /* Derived from a struct of 70 bytes in size */
/*****************************************************************************/
/* Catalog and Authentication control blocks and operation definitions */
typedef SOMLargeStruct AuthParamBlock; /* Derived from a struct of 2232 bytes in size */
typedef SOMLargeStruct DirParamBlock; /* Derived from a struct of 4946 bytes in size */
/* Local Identity API */
/* Trap Dispatchers for Personal Catalog and CSAM Extensions */
#endif
#endif /* __SOMIDL__ */
#endif /* __OCEAUTHDIR_IDL__ */
